home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 5 / Apprentice-Release5.iso / Source Code / Libraries / DCLAP 6d / dclap6d / corelib / ncbierr.h < prev    next >
Text File  |  1996-07-05  |  13KB  |  399 lines
  1. /*   ncbierr.h
  2. * ===========================================================================
  3. *
  4. *                            PUBLIC DOMAIN NOTICE
  5. *               National Center for Biotechnology Information
  6. *
  7. *  This software/database is a "United States Government Work" under the
  8. *  terms of the United States Copyright Act.  It was written as part of
  9. *  the author's official duties as a United States Government employee and
  10. *  thus cannot be copyrighted.  This software/database is freely available
  11. *  to the public for use. The National Library of Medicine and the U.S.
  12. *  Government have not placed any restriction on its use or reproduction.
  13. *
  14. *  Although all reasonable efforts have been taken to ensure the accuracy
  15. *  and reliability of the software and data, the NLM and the U.S.
  16. *  Government do not and cannot warrant the performance or results that
  17. *  may be obtained by using this software or data. The NLM and the U.S.
  18. *  Government disclaim all warranties, express or implied, including
  19. *  warranties of performance, merchantability or fitness for any particular
  20. *  purpose.
  21. *
  22. *  Please cite the author in any work or product based on this material.
  23. *
  24. * ===========================================================================
  25. *
  26. * File Name:  ncbierr.c
  27. *
  28. * Author:  Schuler, Sirotkin (UserErr stuff)
  29. *
  30. * Version Creation Date:   9-19-91
  31. *
  32. * $Revision: 2.22 $
  33. *
  34. * File Description:  Error handling functions
  35. *
  36. * Modifications:
  37. * --------------------------------------------------------------------------
  38. * Date      Name        Description of modification
  39. * --------  ----------  -----------------------------------------------------
  40. * 12-10-93  Schuler     Major Revision.  New APIs include:  ErrPostEx, 
  41. *                       ErrSetMessageLevel, ErrSetFatalLevel, 
  42. * ==========================================================================
  43. */
  44.  
  45. #ifndef _NCBIERR_
  46. #define _NCBIERR_
  47.  
  48. #ifdef __cplusplus
  49. extern "C" {
  50. #endif
  51.  
  52. #include <ncbilcl.h>
  53. #include <ncbistd.h>
  54. #include <ncbimisc.h>
  55.  
  56.  
  57. #ifndef THIS_FILE
  58. #define THIS_FILE  __FILE__
  59. #endif
  60. #ifndef THIS_MODULE
  61. #define THIS_MODULE  NULL
  62. #endif
  63.  
  64. #ifdef _DEBUG
  65. #define DBFLAG 1
  66. #else
  67. #define DBFLAG 0
  68. #endif
  69.  
  70.  
  71. #define E_NoMemory      1
  72. #define E_File          2
  73. #define E_FOpen     3
  74. #define E_FRead     4
  75. #define E_FWrite    5
  76. #define E_CdEject   9
  77. #define E_Math          4
  78. #define E_SGML          3
  79. #define E_Programmer  999
  80.  
  81.  
  82. struct _ErrDesc;     /** Error Descriptor **/
  83. typedef struct _ErrDesc ErrDesc;
  84. #if defined(DCLAP) && !defined(WIN16)
  85. typedef const FAR void *ErrDescPtr;
  86. #else
  87. typedef const FAR *ErrDescPtr;
  88. #endif
  89.  
  90. struct _ErrOpts;      /** Error Options **/
  91. typedef struct _ErrOpts ErrOpts;
  92. #if defined(DCLAP) && !defined(WIN16)
  93. typedef const FAR void *ErrOptsPtr;
  94. #else
  95. typedef const FAR *ErrOptsPtr;
  96. #endif
  97.  
  98. struct _ErrMsgRoot;  /** Root of error message tree **/
  99. typedef struct _ErrMsgRoot  ErrMsgRoot;
  100. typedef const ErrMsgRoot FAR *ErrMsgRootPtr;
  101.  
  102. struct _ErrMsgNode;  /** Node in error message tree **/
  103. typedef struct _ErrMsgNode ErrMsgNode;
  104. typedef const ErrMsgNode FAR *ErrMsgNodePtr;
  105.  
  106.  
  107. /* prototype for user-supplied error handler */
  108. typedef int (LIBCALLBACK *ErrHookProc) PROTO((const ErrDesc *err));
  109.  
  110. /***************************************************************************\
  111. |                           POSTING AN ERROR                                |
  112. \***************************************************************************/
  113.  
  114. enum _ErrSev { SEV_NONE=0, SEV_INFO, SEV_WARNING, SEV_ERROR, SEV_FATAL };
  115. typedef enum _ErrSev ErrSev;
  116.  
  117. #define SEV_MIN  SEV_INFO
  118. #define SEV_MAX (SEV_FATAL+1)
  119.  
  120. void CDECL Nlm_ErrPost VPROTO((int ctx, int code, const char *fmt, ...));
  121. int CDECL Nlm_ErrPostEx VPROTO((ErrSev sev, int lev1, int lev2, const char *fmt, ...));
  122. int LIBCALL Nlm_ErrPostStr PROTO((ErrSev sev, int lev1, int lev2, const char *str));
  123. void CDECL Nlm_ErrLogPrintf VPROTO((const char *fmt, ...));
  124. void LIBCALL Nlm_ErrLogPrintStr PROTO((const char *str));
  125. int LIBCALL Nlm_ErrSetContext PROTO((const char *ctx, const char *fn, int ln, int db));
  126.  
  127. #define ErrPost    \
  128.     (Nlm_ErrSetContext(THIS_MODULE,THIS_FILE,__LINE__,DBFLAG)) ? (void)0 : \
  129.     Nlm_ErrPost
  130.  
  131. #define ErrPostEx    \
  132.     (Nlm_ErrSetContext(THIS_MODULE,THIS_FILE,__LINE__,DBFLAG)) ? 0 : \
  133.     Nlm_ErrPostEx
  134.  
  135. #define ErrPostStr  \
  136.     (Nlm_ErrSetContext(THIS_MODULE,THIS_FILE,__LINE__,DBFLAG)) ? 0 : \
  137.     Nlm_ErrPostStr
  138.  
  139. #define ErrLogPrintf  Nlm_ErrLogPrintf
  140. #define ErrLogPrintStr Nlm_ErrLogPrintStr
  141.  
  142. /***************************************************************************\
  143. |                     FETCHING AND REPORTING ERRORS                         |
  144. \***************************************************************************/
  145. #define ERRTEXT_MAX  512
  146. #define CODESTR_MAX  64
  147. #define MODSTR_MAX   32
  148. #define SRCFILE_MAX  92
  149.  
  150. struct _ErrDesc 
  151. {
  152.     short severity;
  153.     short context;  /* OBSOLETE */
  154.     char  module[MODSTR_MAX];
  155.     int   errcode;
  156.     int   subcode;
  157.     char  codestr[CODESTR_MAX];
  158.     char  srcfile[SRCFILE_MAX];
  159.     int   srcline;
  160.     char  errtext[ERRTEXT_MAX];
  161.     const ValNode *userstr;
  162.     const ErrMsgRoot *root;
  163.     const ErrMsgNode *node;
  164. };
  165.  
  166. int LIBCALL Nlm_ErrFetch PROTO((ErrDesc FAR *err));
  167. int LIBCALL Nlm_ErrCopy PROTO((ErrDesc FAR *err));
  168. void LIBCALL Nlm_ErrClear PROTO((void));
  169. int LIBCALL Nlm_ErrShow PROTO((void));
  170.  
  171. #define ErrShow     Nlm_ErrShow
  172. #define ErrFetch    Nlm_ErrFetch
  173. #define ErrClear    Nlm_ErrClear
  174. #define ErrCopy     Nlm_ErrCopy
  175. #define ErrPeek()   Nlm_ErrCopy(NULL)
  176.  
  177.  
  178. /***************************************************************************\
  179. |                           MESSAGE FILE SUPPORT                            |
  180. \***************************************************************************/
  181. struct _ErrMsgRoot
  182. { 
  183.     ErrMsgRoot *next;
  184.     ErrMsgNode *list;
  185.     const char *name;
  186.     /*unsigned int busy :1;*/
  187.     /*unsigned int not_avail :1;*/
  188. };
  189.  
  190. struct _ErrMsgNode
  191. { 
  192.     ErrMsgNode *next;
  193.     ErrMsgNode *list;
  194.     const char *name;
  195.     int code;
  196.     int sev;
  197.     long cofs, clen;
  198.     long tofs, tlen;
  199.     const char *cstr;    
  200.     const char *tstr;
  201. };
  202.  
  203. /** Don't use these functions **/
  204. ErrMsgRootPtr LIBCALL ErrGetMsgRoot PROTO((const char *context));
  205. const char* LIBCALL ErrGetExplanation PROTO((ErrMsgRootPtr idx, ErrMsgNodePtr item));
  206.  
  207. /***************************************************************************\
  208. |                             CUSTOMIZATION                                 |
  209. \***************************************************************************/
  210. struct _ErrOpts
  211. {
  212.     unsigned long flags;
  213.     short log_level;
  214.     short msg_level;
  215.     short die_level;
  216.     short actopt;
  217.     short logopt;
  218. };
  219.  
  220. typedef Nlm_Uint1 ErrStrId;
  221.  
  222. int LIBCALL Nlm_ErrSetLogfile PROTO((const char *filename, unsigned long flags));
  223. ErrHookProc LIBCALL Nlm_ErrSetHandler PROTO((ErrHookProc));
  224. ErrStrId LIBCALL Nlm_ErrUserInstall PROTO((const char *msg, ErrStrId magic_cookie));
  225. Nlm_Boolean LIBCALL Nlm_ErrUserDelete PROTO((ErrStrId magic_cookie));
  226. void LIBCALL Nlm_ErrUserClear PROTO((void));
  227. int LIBCALL ErrSetLogLevel PROTO((ErrSev level));
  228. int LIBCALL ErrGetLogLevel PROTO((void));
  229. int LIBCALL ErrSetMessageLevel PROTO((ErrSev level));
  230. int LIBCALL ErrGetMessageLevel PROTO((void));
  231. int LIBCALL ErrSetFatalLevel PROTO((ErrSev level));
  232. int LIBCALL ErrGetFatalLevel PROTO((void));
  233. unsigned long LIBCALL ErrSetOptFlags PROTO((unsigned long flags));
  234. unsigned long LIBCALL ErrClearOptFlags PROTO((unsigned long flags));
  235. unsigned long LIBCALL ErrTestOptFlags PROTO((unsigned long flags));
  236. void LIBCALL ErrSaveOptions PROTO((ErrOpts *opts)); 
  237. void LIBCALL ErrRestoreOptions PROTO((const ErrOpts *opts));
  238.  
  239. /* Error Option (EO) flags */
  240. #define EO_LOG_SEVERITY  0x00000001L
  241. #define EO_LOG_CODES     0x00000002L
  242. #define EO_LOG_FILELINE  0x00000004L
  243. #define EO_LOG_USERSTR   0x00000008L
  244. #define EO_LOG_ERRTEXT   0x00000010L
  245. #define EO_LOG_MSGTEXT   0x00000020L
  246. #define EO_MSG_SEVERITY  0x00000100L
  247. #define EO_MSG_CODES     0x00000200L
  248. #define EO_MSG_FILELINE  0x00000400L
  249. #define EO_MSG_USERSTR   0x00000800L
  250. #define EO_MSG_ERRTEXT   0x00001000L
  251. #define EO_MSG_MSGTEXT   0x00002000L
  252. #define EO_LOGTO_STDOUT  0x00010000L
  253. #define EO_LOGTO_STDERR  0x00020000L
  254. #define EO_LOGTO_TRACE   0x00040000L
  255. #define EO_LOGTO_USRFILE 0x00080000L
  256. #define EO_XLATE_CODES   0x01000000L
  257. #define EO_WAIT_KEY      0x02000000L
  258. #define EO_PROMPT_ABORT  0x04000000L
  259. #define EO_BEEP          0x08000000L
  260.  
  261. #define EO_ALL_FLAGS     0x0F0F3F3FL
  262.  
  263. #define EO_SHOW_SEVERITY (EO_LOG_SEVERITY | EO_MSG_SEVERITY)
  264. #define EO_SHOW_CODES    (EO_LOG_CODES | EO_MSG_CODES)
  265. #define EO_SHOW_FILELINE (EO_LOG_FILELINE | EO_MSG_FILELINE)
  266. #define EO_SHOW_USERSTR  (EO_LOG_USERSTR | EO_MSG_USERSTR)
  267. #define EO_SHOW_ERRTEXT  (EO_LOG_ERRTEXT | EO_MSG_ERRTEXT)
  268. #define EO_SHOW_MSGTEXT  (EO_LOG_MSGTEXT | EO_MSG_MSGTEXT)
  269.  
  270. #define EO_DEFAULTS      (EO_SHOW_SEVERITY | EO_LOG_CODES | EO_XLATE_CODES | \
  271.                 EO_SHOW_USERSTR | EO_SHOW_ERRTEXT)
  272.  
  273. /* flags for ErrSetLogfile */
  274. #define ELOG_APPEND         0x00000001
  275. #define ELOG_BANNER      0x00000002
  276. #define ELOG_NOCREATE    0x00000004
  277.  
  278. #define ErrSetHandler Nlm_ErrSetHandler
  279. #define ErrUserInstall Nlm_ErrUserInstall
  280. #define ErrUserDelete  Nlm_ErrUserDelete
  281. #define ErrUserClear   Nlm_ErrUserClear
  282. #define ErrSetLogfile   Nlm_ErrSetLogfile
  283. #define ErrSetLog(x)  Nlm_ErrSetLogfile((x),ELOG_BANNER|ELOG_APPEND)
  284.  
  285. /***************************************************************************\
  286. |                               DEBUGGING                                   |
  287. \***************************************************************************/
  288. void LIBCALL Nlm_AssertionFailed PROTO((const char*, const char*,const char*,int));
  289. void LIBCALL Nlm_TraceStr PROTO((const char*));
  290. void CDECL   Nlm_Trace VPROTO((const char*, ...));
  291. void LIBCALL Nlm_AbnormalExit PROTO((int));
  292.  
  293. #define AbnormalExit  Nlm_AbnormalExit
  294.  
  295. #ifdef _DEBUG
  296.  
  297. #ifndef TRACE                        
  298. #define TRACE    Nlm_Trace
  299. #endif
  300. #ifndef ASSERT
  301. #define ASSERT(expr)  ((expr) ? \
  302.     (void)0 : Nlm_AssertionFailed(#expr,THIS_MODULE,THIS_FILE,__LINE__))
  303. #endif
  304. #ifndef VERIFY
  305. #define VERIFY(expr)  ASSERT(expr)
  306. #endif
  307.  
  308. #else /* ! _DEBUG */
  309.  
  310. #ifndef TRACE
  311. #define TRACE    1 ? (void)0 : Nlm_Trace
  312. #endif
  313. #ifndef ASSERT
  314. #define ASSERT(expr)    ((void)0)
  315. #endif
  316. #ifndef VERIFY
  317. #define VERIFY(expr)    ((void)(expr))
  318. #endif
  319.  
  320. #endif  /* ! _DEBUG */
  321.  
  322. /********************* OBSOLETE STUFF BELOW THIS LINE **********************/
  323.  
  324. /* actopt codes */
  325. #define ERR_CONTINUE  1
  326. #define ERR_IGNORE    2
  327. #define ERR_ADVISE    3
  328. #define ERR_ABORT     4
  329. #define ERR_PROMPT    5
  330. #define ERR_TEE       6
  331.  
  332. /* logopt codes */
  333. #define ERR_LOG_ON    1
  334. #define ERR_LOG_OFF   2
  335.  
  336. void LIBCALL Nlm_ErrGetOpts PROTO((short * actopt, short * logopt));
  337. void LIBCALL Nlm_ErrSetOpts PROTO((short actopt, short logopt));
  338. #define ErrGetOpts  Nlm_ErrGetOpts
  339. #define ErrSetOpts  Nlm_ErrSetOpts
  340.  
  341. /* error context codes */
  342. #define CTX_DEBUG      0
  343. #define CTX_UNKNOWN    1
  344. #define CTX_ERRNO      2
  345. #define CTX_NCBICORE   64
  346. #define CTX_NCBIASN1   65
  347. #define CTX_NCBICD       66
  348. #define CTX_NCBIOBJ    67
  349. #define CTX_NCBILMA    68
  350. #define CTX_NCBIGBPARSE 69
  351. #define CTX_NCBIPIRPARSE 70
  352. #define CTX_NCBI2GB    71
  353. #define CTX_NCBIBB2ASN 72
  354. #define CTX_NCBIMATH   73
  355. #define CTX_NCBIMED2ASN 74
  356. #define CTX_NCBISEQENTRY 75
  357. #define CTX_NCBISEQPORT   200
  358. #define CTX_NCBIIDLOAD 300
  359. #define CTX_NCBIIDPROCESS 301
  360. #define CTX_NCBIIDRETRIEVE 302
  361. #define CTX_NCBIAUTHINPARSE 303
  362. #define CTX_KB2ASN 304
  363.  
  364. #define CTX_RESERVED   10000
  365. /* context codes > 10000 are available for application use */
  366. #define CTX_USER       32767    /* default user application context */
  367.  
  368. /* error codes for CTX_NCBICORE */
  369. #define CORE_UNKNOWN    1
  370. #define CORE_NULLPTR    2    /* NULL pointer passed as an argument */
  371. #define CORE_NULLHND    3    /* NULL handle passed as an argument */
  372. #define CORE_MEMORY     4    /* Memory allocation failure */
  373. #define CORE_BAD_COOKIE 5    /* ErrPost User install misused */
  374. #define CORE_BAD_SGML   6    /* SGML entity or range error */
  375.  
  376. #define CORE_FILE_ACCESS  10  /* Error accessing file */
  377. #define CORE_FILE_CREATE  11  /* Error creating file */
  378. #define CORE_FILE_OPEN    12  /* Error opening file */
  379. #define CORE_FILE_READ    13  /* Error reading file */
  380. #define CORE_FILE_WRITE   14  /* Error writing file */
  381. #define CORE_FILE_ERROR   15  /* any other file I/O error */
  382.  
  383. #define ERRPOST(x)    \
  384.     Nlm_ErrSetContext(THIS_MODULE,THIS_FILE,__LINE__,DBFLAG), \
  385.     Nlm_ErrPost x
  386.  
  387. #define Nlm_ErrSetLog(x)  Nlm_ErrSetLogfile((x),ELOG_BANNER|ELOG_APPEND)
  388.  
  389. #define EO_LOG_STDOUT  EO_LOGTO_STDOUT
  390. #define EO_LOG_STDERR  EO_LOGTO_STDERR
  391. #define EO_LOG_TRACE   EO_LOGTO_TRACE 
  392. #define EO_LOG_USRFILE EO_LOGTO_USRFILE
  393.  
  394. #ifdef __cplusplus
  395. }
  396. #endif
  397.  
  398. #endif
  399.